home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfrom100.zip / SFROM.DOC < prev    next >
Text File  |  1992-05-31  |  22KB  |  482 lines
  1.  
  2.                               SF ROM DOOR
  3.                               Version 1.0
  4.                           Released May 31, 1992
  5.  
  6.                            Copyright (C) 1992
  7.                             by Mike Robinson
  8.  
  9.                             The Soft Parade
  10.                         Shelton, Connecticut, USA
  11.                              203-924-5603
  12.  
  13. ------- OVERVIEW ------------------------------------------------------------
  14.  
  15.         SF ROM Door is a file access door designed for use on Spitfire BBS.
  16.         It can be used to access file areas on a CD-ROM disk, a "normal"
  17.         magnetic disk, or both. It provides browsing, text search and
  18.         download capabilities from within the door. It can even track the
  19.         number of files/bytes downloaded, enforce daily limits, and then
  20.         record this information in the main Spitfire database. A Spitfire
  21.         SFFILES.BBS type of file list is required for each file area. The
  22.         door can be run from the door menu or any of the menu extensions.
  23.  
  24.         Speed.
  25.  
  26.         Nothing in this world ever seems to go fast enough. Right from the
  27.         beginning this door was designed and optimized for speed. And it is
  28.         FAST. I know of no other door that even comes close. A file search of
  29.         a 500 megabyte CD-ROM disk takes only a few seconds.
  30.  
  31.         Speed is especially important to those who run multiple nodes and/or
  32.         multiple CD-ROM drives such as the Pioneer DRM-600 "six pack."
  33.         Considerable time and energy was spent working around the speed
  34.         limitations of today's CD-ROM drives. Actual CD-ROM drive hardware
  35.         access time has been minimized by:
  36.  
  37.         1. Maintaining the file lists on the magnetic drive. This is
  38.            optional. If the CD-ROM itself contains file lists, these can be
  39.            be accessed directly by the door in order to save hard drive
  40.            space.
  41.  
  42.         2. Copying the file to a holding directory on the hard drive and
  43.            downloading it from there. This is also optional. You can
  44.            configure the door to download directly from the CD-ROM drive.
  45.  
  46.         3. Careful design of the the door logic. The CD-ROM drive hardware is
  47.            accessed as rapidly as possible and only when absolutely required.
  48.  
  49.  
  50. ------- FEATURES ------------------------------------------------------------
  51.  
  52.         ■ Number of files/bytes downloaded is recorded in the Spifire main
  53.           database and daily download limits are enforced.
  54.           (This feature is NOT available in unregistered versions.)
  55.  
  56.         ■ Caller time in door is limited to remaining time allowed on BBS.
  57.           (This feature is available in ALL versions.)
  58.  
  59.         ■ Complete logging of all caller activity.
  60.           (This feature is NOT available in unregistered versions.)
  61.  
  62.         ■ Download from within door using Xmodem, Ymodem or Zmodem.
  63.           A copy of DSZ.COM or DSZ.EXE by Omen Technology Incorporated
  64.           is required.
  65.  
  66.         ■ Up to 1000 separate file areas.
  67.  
  68.         ■ Very rapid text search of both file names and descriptions.
  69.           Matches are highlighted in color.
  70.  
  71.         ■ File sharing and locking for multinode and network operation.
  72.           All file lists, menus, data files and logs may be shared.
  73.           DOS version 3.0 or higher, with DOS SHARE installed, is required
  74.           for proper operation of file sharing and locking.
  75.  
  76.         ■ DESQview aware. When idle the program automatically releases
  77.           it's clock ticks to applications running in the other windows.
  78.  
  79.         ■ Multi-colored file lists just like seen in Spitfire 3.2.
  80.  
  81.         ■ Run as a door or menu extension using SFDOORS.DAT, SFFILE.DAT,
  82.           SFMESS.DAT or SFMAIN.DAT.
  83.  
  84.         ■ Automatically uses Spitfire's communication port settings.
  85.           Comm port speeds to 38,400 bps with hardware or software flow
  86.           control. Uses Spitfire's configured port speed, data bits, stop
  87.           bit, parity, comm port, I/O port and interrupt. Handles any UART.
  88.           Does not require or use a FOSSIL driver, but is compatible with a
  89.           FOSSIL if one is installed.
  90.  
  91.         ■ Detailed status line visible on top of local screen at all times.
  92.           Shows caller name, statistics, time left, etc.
  93.  
  94.         ■ Detailed status screen displayed during download.
  95.           Shows callers's entire download/upload history and more.
  96.  
  97.         ■ Sysop local keyboard controls same as Spitfire:
  98.  
  99.               ALT+C --- Chat Mode On/Off
  100.               ALT+D --- Drop To DOS (local sysop only)
  101.               ALT+J --- Drop To DOS (local sysop only)
  102.               F6 ------ Take Five Minutes From Caller
  103.               F7 ------ Give Five Minutes To Caller
  104.               F10 ----- Exit The Door
  105.               ALT+F1 -- Exit The Door
  106.               ALT+F2 -- Exit The Door
  107.  
  108.         ■ Carrier detection. Resets the BBS if caller drops carrier.
  109.  
  110.         ■ Inactivity timeout configurable from 1 to 10 minutes.
  111.  
  112.         ■ ANSI color or plain ASCII text modes. Initial mode is the same as
  113.           passed by Spitfire. Caller can toggle ANSI on/off from within the
  114.           door. Door contains its own ANSI driver and can show ANSI graphics
  115.           on the local screen even if DOS ANSI.SYS is not loaded.
  116.  
  117.         ■ Sysops can design their own (optional) custom screens.
  118.           Door will display WELCOME.CLR or WELCOME.BBS before it runs.
  119.           Door will display GOODBYE.CLR or GOODBYE.BBS after  it runs.
  120.           Place these in the same directory as SFROM.EXE.
  121.           If ANSI is on then the .CLR files will be shown, otherwise
  122.           the .BBS file will be shown.
  123.  
  124.         ■ Low memory requirements. Only uses about 120 kilobytes.
  125.  
  126.  
  127. ------- SETUP ---------------------------------------------------------------
  128.  
  129.         1. Unzip this archive into one subdirectory.
  130.            This will be the SFROM home directory.
  131.  
  132.         2. Modify the included SFROM.CFG file to meet your needs.
  133.            Any line in SFROM.CFG that does not begin with a letter is
  134.            ignored. The lines that begin with semicolons, for example, are
  135.            used for comments and ignored by the program. See detailed
  136.            instructions for each line of SFROM.CFG below.
  137.            Keep this file in the SFROM home directory.
  138.  
  139.         3. Modify the included AREALIST.CLR and AREALIST.BBS to meet your
  140.            needs. These two files are the main program menu and are mandatory
  141.            or the program will not run. Try to keep these to under 21
  142.            displayed lines or the top may scroll off the screen.
  143.            Keep these files in the SFROM home directory.
  144.  
  145.         4. Make sure a copy of DSZ.COM or DSZ.EXE is somewhere on your DOS
  146.            path or in the SFROM home directory.
  147.  
  148.         5. (OPTIONAL) Place custom screens WELCOME.CLR, WELCOME.BBS,
  149.            GOODBYE.CLR and GOODBYE.BBS in the SFROM home directory.
  150.            The door will display these files if they exist.
  151.  
  152.         6. Run the program using any ONE
  153.            of these command lines:
  154.  
  155.            COMMAND LINE
  156.            ------------
  157.            SFROM C:\SF\SFDOORS.DAT               ( doors menu )
  158.  
  159.            SFROM C:\SF\SFFILE.DAT                ( file menu extension )
  160.  
  161.            SFROM C:\SF\SFMAIN.DAT                ( main menu extension )
  162.  
  163.            SFROM C:\SF\SFMESS.DAT                ( message menu extension )
  164.  
  165.            SFROM LOCAL                           ( local test mode )
  166.  
  167.            The complete path and file name must be specified except for
  168.            local mode as shown. Spitfire creates one of the above files
  169.            whenever the door menu or one of the menu extensions is executed.
  170.  
  171.  
  172.            (OPTIONAL)
  173.            All of the above examples assume that a configuration file named
  174.            SFROM.CFG is in the SFROM home directory. You may also specify a
  175.            different configuration file on the command line like this:
  176.  
  177.            SFROM C:\SF\SFFILE.DAT C:\SF\CDROM2\MYCONFIG.FIL
  178.  
  179.  
  180.  
  181. ------- SFROM.CFG -----------------------------------------------------------
  182.  
  183.         SFROM.CFG is the main configuration file which supplies the door with
  184.         the information it requires to run properly. It should be placed in
  185.         the SFROM home directory. The program reads each line in this file.
  186.         If the line begins with a keyword then the configuration is modified
  187.         according to the information that follows the keyword. If a line
  188.         begins with anything other than a letter, it is ignored. The
  189.         explanatory comments below are all on lines beginning with
  190.         semicolons. The order of the lines is generally not important except
  191.         for the file areas. The keywords are NOT case sensitive, but they
  192.         must be spelled correctly.
  193.  
  194.  
  195.         DiskName So Much Shareware
  196.         ; This name is used in the door log entries. It is only used in
  197.         ; registered versions.
  198.  
  199.  
  200.         HoldDir  C:\SF\CD-HOLD
  201.         ; If this keyword is used, then files selected for download will be
  202.         ; copied to the directory specified. If this keyword is not used then
  203.         ; files will be downloaded directly from the CD-ROM.
  204.         ; Default is the root directory C:\
  205.         ; The program takes care of its own housekeeping and deletes the
  206.         ; copied files after the download. Just the copied files are deleted.
  207.         ; Any other files that exist in this directory will NOT be deleted.
  208.  
  209.  
  210.         LogName  C:\SF\CALLERS.TMP
  211.         ; Registered versions only.
  212.         ; Gives the name of the caller activity log file.
  213.         ; Default is CALLERS.TMP in the Spitfire home directory for this
  214.         ; node as defined in SFFILE.DAT or equivalent.
  215.  
  216.         Share ON
  217.         Share OFF
  218.         ; Turns file sharing and locking ON or OFF.
  219.         ; File sharing is generally not required on a single-node BBS.
  220.         ; This program will run much faster with Share OFF.
  221.         ; The default is Share ON.
  222.  
  223.  
  224.         TimeOut 180
  225.         ; This is the caller inactivity timeout delay in seconds.
  226.         ; If no keystrokes are received for this length of time, the door
  227.         ; will exit and return the caller to the BBS.
  228.         ; Values from 60 to 600 seconds are allowed.
  229.         ; The default value is 180 seconds (3 minutes).
  230.  
  231.  
  232.         ScrollDelay 3
  233.         ; This is the delay in milliseconds between display of each line.
  234.         ; You should probably not mess with this.
  235.         ; Values from 0 to 30 are allowed.
  236.         ; The default is 3.
  237.  
  238.  
  239.         Debug ON
  240.         Debug OFF
  241.         ; Most program error conditions are logged to SFROM.LOG if Debug is
  242.         ; turned on. The program may load a bit faster if you turn this off.
  243.         ; If you are experiencing difficulties, leave Debug ON.
  244.         ; The default is Debug ON.
  245.  
  246.  
  247.         DirectVideo ON
  248.         DirectVideo OFF
  249.         ; With DirectVideo ON, all local screen writes will done directly to
  250.         ; video memory instead of through the BIOS.
  251.         ; The default is DirectVideo ON. This seems to work fine on most
  252.         ; systems.
  253.  
  254.  
  255.         CheckSnow ON
  256.         CheckSnow OFF
  257.         ; CheckSnow ON enables "snow checking" when using DirectVideo ON.
  258.         ; It has no effect if DirectVideo OFF.
  259.         ; Some older CGA dipsplays may requires this. It should not be a
  260.         ; problem on most monochrome, EGA or VGA video systems.
  261.         ; Some systems may run a bit faster with CheckSnow OFF.
  262.         ; The default is CheckSnow ON.
  263.  
  264.  
  265.         BiosScroll ON
  266.         BiosScroll OFF
  267.         ; If BiosScroll OFF, then a special scrolling routine is used that
  268.         ; suppresses snow and flicker on systems with any kind of color
  269.         ; graphics. However, BiosScroll ON is a bit faster.
  270.         ; The default is BiosScroll ON.
  271.  
  272.  
  273.         ; The following defines your file areas. This is VERY IMPORTANT.
  274.         ; These must be one area per line on consecutive lines. The first
  275.         ; line is file area number 1 and the rest follow in order until you
  276.         ; reach the end.
  277.         ; The list MUST BEGIN and END with the keyword "Areas".
  278.         ; The list MUST BEGIN and END with the keyword "Areas".
  279.         ; Each line has two entries separated by at least one blank space.
  280.         ; The first is the path to the file area on the CD-ROM. The second is
  281.         ; the full path and filename of the associated file list. The list
  282.         ; can have any filename, it does not have to be sffiles.bbs.
  283.  
  284.         Areas
  285.         E:\ASM      C:\SF\CDROM1\ASM.LST
  286.         E:\BUDGET   C:\SF\CDROM1\BUDGET.LST
  287.         E:\CLIPART  C:\SF\CDROM1\CLIPART.LST
  288.         E:\CPROG    C:\SF\CDROM1\CPROG.LST
  289.         E:\DATABASE C:\SF\CDROM1\DATABASE.LST
  290.         E:\DEMOS    C:\SF\CDROM1\DEMOS.LST
  291.         E:\DESKTOP  C:\SF\CDROM1\DESKTOP.LST
  292.         E:\EDUCATE  C:\SF\CDROM1\EDUCATE.LST
  293.         E:\FINANCE  C:\SF\CDROM1\FINANCE.LST
  294.         E:\GAMES1   C:\SF\CDROM1\GAMES1.LST
  295.         E:\GAMES2   C:\SF\CDROM1\GAMES2.LST
  296.         E:\GENERAL  C:\SF\CDROM1\GENERAL.LST
  297.         E:\GIFS     C:\SF\CDROM1\GIFS.LST
  298.         E:\GRAPHICS C:\SF\CDROM1\GRAPHICS.LST
  299.         E:\HOBBY    C:\SF\CDROM1\HOBBY.LST
  300.         E:\LASER    C:\SF\CDROM1\LASER.LST
  301.         E:\MODEM    C:\SF\CDROM1\MODEM.LST
  302.         E:\MUSIC    C:\SF\CDROM1\MUSIC.LST
  303.         E:\PASCAL   C:\SF\CDROM1\PASCAL.LST
  304.         E:\PROG     C:\SF\CDROM1\PROG.LST
  305.         E:\QB       C:\SF\CDROM1\QB.LST
  306.         E:\SOSGIFS  C:\SF\CDROM1\SOSGIFS.LST
  307.         E:\SWIMSUIT C:\SF\CDROM1\SWIMSUIT.LST
  308.         E:\UTIL1    C:\SF\CDROM1\UTIL1.LST
  309.         E:\UTIL2    C:\SF\CDROM1\UTIL2.LST
  310.         E:\WIN1     C:\SF\CDROM1\WIN1.LST
  311.         E:\WIN2     C:\SF\CDROM1\WIN2.LST
  312.         E:\WORD     C:\SF\CDROM1\WORD.LST
  313.         Areas
  314.  
  315.  
  316.         ; The file lists can be located on a normal magnetic hard disk or on
  317.         ; the CD-ROM (if they exist on the CD-ROM). The door will run much
  318.         ; faster if you locate the file lists on the normal magnetic hard
  319.         ; disk. Note that you can also use this door to access normal file
  320.         ; areas on your hard drive. You can mix normal file areas with CD-ROM
  321.         ; areas in the same door. The file areas do not have to reside on the
  322.         ; same drive letter or same physical drive. If you have a network,
  323.         ; you can access file area on a different machine. You could even put
  324.         ; ALL of your Spitfire file areas in one or more of these doors. For
  325.         ; example, you could put all your naked-lady GIFs in one door and
  326.         ; restrict access to adults only. Or you could have special file
  327.         ; doors reserved for privileged, contributing or subscribing callers.
  328.  
  329.         ; The example above is also used in the sample SFROM.CFG supplied in
  330.         ; this package. It is for the "So Much Shareware #1" CD-ROM disk
  331.         ; first published in late 1991. The file lists are resident on the
  332.         ; CD-ROM as SFFILES.BBS in each subdirectory and can be easily
  333.         ; copied to a hard drive.
  334.  
  335.  
  336. ------- REGISTRATION --------------------------------------------------------
  337.  
  338.         This is SHAREWARE. You may use this program for a free 30 day trial
  339.         period. After that, you must register it or stop using it.
  340.         You may give away free copies of this entire unmodified package,
  341.         but you may not sell it. I retain all rights to this program.
  342.  
  343.         As an incentive to encourage registration, the following features
  344.         are ONLY AVAILABLE IN THE REGISTERED VERSION:
  345.  
  346.         ■ The *** UNREGISTERED ***  message on the first screen is replaced
  347.           by your name and your BBS Name.
  348.  
  349.         ■ Spitfire's daily download file and byte limits will be enforced by
  350.           the door. The door will also record all downloads and add the
  351.           number of files and bytes downloaded to the main Spitfire data
  352.           base. So the caller's total daily downloads (sum of downloads
  353.           inside the door and normal Spitfire downloads) will never be more
  354.           than allowed by Spitfire in DAILYLMT.DAT. These limits are
  355.           correctly tracked in any combination, even if the caller enters and
  356.           exits the door several times. If Spitfire says a caller can only
  357.           grab 10 files per day, he will only be able to grab 10 files total
  358.           per day.
  359.  
  360.             example:
  361.             A caller is allowed 10 downloads per day. He downloads 3 files in
  362.             this door. He is then only allowed 7 more downloads when he
  363.             returns to Spitfire.
  364.  
  365.           In the unregistered version, only the caller's daily time limit is
  366.           enforced. In the unregistered version, downloads are not recorded
  367.           and file/byte per day limits are not enforced.
  368.  
  369.         ■ Full logging of all caller activities in the door to CALLERS.LOG
  370.           or any file you choose. These log entries are designed to blend
  371.           nicely with the normal Spitfire log entries.
  372.           Here is an example from the CALLERS.LOG on my BBS:
  373.           -------------------------------------------------------------------
  374.           John Smith called at 19:06:46 on 05-18-92 using Node 1 at 2400 baud.
  375.              ANSI Color Graphics Selected.
  376.              Entered So Much Shareware SF-ROM Door at 19:09:16
  377.                117,730  05-17-90  A Star Trek Game For Vga Only!
  378.                Begin DownLoad VGATREK.ZIP  19:20:22  Estimated Time:  8.5 Min.
  379.                End   DownLoad VGATREK.ZIP  19:28:51     Actual Time:  8.5 Min.
  380.                Updated caller download records +1 file.
  381.                 15,269  09-05-91  Grab Address From App & Print Envelope
  382.                Begin DownLoad WNVEL20.ZIP  19:40:03  Estimated Time:  1.1 Min.
  383.                End   DownLoad WNVEL20.ZIP  19:41:12     Actual Time:  1.1 Min.
  384.                Updated caller download records +1 file.
  385.              Exited  So Much Shareware SF-ROM Door at 19:42:50
  386.           John Smith logged off at 19:43:20
  387.           -------------------------------------------------------------------
  388.  
  389.         In the unregistered version, only error conditions are logged.
  390.         No caller activity log is created in the unregistered version.
  391.  
  392.  
  393.  
  394.         Registration is $15 (fifteen) dollars in US funds.
  395.         Personal check, bank check or money orders are acceptable.
  396.  
  397.         Registered Sysops are entitled to free program support, free upgrades
  398.         to all future versions, and free access to all files and features on
  399.         my BBS. Support is available from me on my BBS, in CircuitNet and in
  400.         FidoNet. Suggestions for future improvements from registered Sysops
  401.         will receive careful consideration.
  402.  
  403.         In order to register the program, you will have to call my BBS and
  404.         download your personal registration key and instruction file.
  405.         This key will work for all future versions, so there will be no need
  406.         to download any specially compiled versions of the executable program
  407.         itself.
  408.  
  409.         If you do not yet have access to my BBS, please be sure to send
  410.         along a password and birthdate with your registration. Then I can set
  411.         up your logon account in advance. Please be sure to specify your name
  412.         and your BBS name exactly as you would like them to appear on the
  413.         first door screen.
  414.  
  415.         -------------------------------------------------------
  416.         -------------------------------------------------------
  417.         -------------------------------------------------------
  418.  
  419.                      SF ROM Door REGISTRATION FORM
  420.  
  421.         Your Name:
  422.         (40 characters maximum)
  423.  
  424.         BBS Name:
  425.         (40 characters maximum)
  426.  
  427.         BBS Phone Number:
  428.         (xxx-xxx-xxxx)
  429.  
  430.         Password to use on  Mike Robinson's BBS:
  431.         (14 characters maximum)
  432.  
  433.         BirthDate to use on Mike Robinson's BBS:
  434.         (mm-dd-yy)
  435.  
  436.         Your Address:
  437.  
  438.         Send this form and $15 (fifteen) dollars in US funds to:
  439.  
  440.         Michael Robinson
  441.         9 Richard Boulevard
  442.         Shelton, CT. 06484
  443.  
  444.         Personal check, bank check or money orders are acceptable.
  445.  
  446.         -------------------------------------------------------
  447.         -------------------------------------------------------
  448.         -------------------------------------------------------
  449.  
  450.         ╔═══════════════════╗ ╔══════════════════════╗ ╔═══════════════════╗
  451.         ║  The Soft Parade  ║ ║ Sysop: Mike Robinson ║ ║ 1200 to 14400 bps ║
  452.         ║  Shelton, CT. USA ║ ║ Spitfire version 3.2 ║ ║ HST   V.32   V.42 ║
  453.         ║   203-924-5603    ║ ║ Open 24 hours 7 days ║ ║  MNP 5   V.42bis  ║
  454.         ║ FidoNet 1:141/485 ║ ║  CircuitNet  203004  ║ ║ USR Dual Standard ║
  455.         ╚═══════════════════╝ ╚══════════════════════╝ ╚═══════════════════╝
  456.  
  457.         Thanks to beta testers Bill Arlofski, Dave Clark, Don Hutson,
  458.         Ed Miller, Steve Newman.
  459.  
  460.         Legal Stuff:
  461.         Use this program at your own risk. No guarantees of any sort.
  462.         "Spitfire" is a registered trademark of Buffalo Creek Software.
  463.         File sharing and locking implemented via BCSHARE Beta Version 0.7
  464.         Copyright (C) By Mike Woltz 1990 Buffalo Creek Software.
  465.  
  466.         SF ROM Revision History -
  467.         Version 1.0 - Initial Public Release - May 31, 1992
  468.  
  469.  
  470.  
  471.         And God said: 'Let there be light.' And there was light.
  472.         And God saw the light, that it was good;
  473.         and God divided the light from the darkness.
  474.                                 - Genesis 1.1
  475.                  _
  476.         Las·er (la'zer) n. [l(ight) a(mplification by) s(timulated)
  477.           e(mission of) r(adiation)] a device containing a crystal, gas,
  478.           or other suitable substance, in which atoms, when stimulated by
  479.           focused light waves, amplify and concentrate these waves, then
  480.           emit them in a narrow, very intense beam
  481.                                 - Webster's New World Dictionary
  482.